home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3dm / audio / alGetFillable.z / alGetFillable
Encoding:
Text File  |  1998-10-20  |  3.1 KB  |  67 lines
  1.  
  2.  
  3.  
  4. aaaallllGGGGeeeettttFFFFiiiillllllllaaaabbbblllleeee((((3333ddddmmmm))))                                          aaaallllGGGGeeeettttFFFFiiiillllllllaaaabbbblllleeee((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      alGetFillable - report the number of unfilled sample frames in an audio
  10.      port
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiioooo....hhhh>>>>
  14.  
  15.      iiiinnnntttt aaaallllGGGGeeeettttFFFFiiiillllllllaaaabbbblllleeee((((AAAALLLLppppoooorrrrtttt ppppoooorrrrtttt))))
  16.  
  17. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  18.      _p_o_r_t   expects the audio port you want to query.  This structure is the
  19.             returned value of the aaaallllOOOOppppeeeennnnPPPPoooorrrrtttt((((3333ddddmmmm)))) call.
  20.  
  21. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  22.      aaaallllGGGGeeeettttFFFFiiiillllllllaaaabbbblllleeee returns the number of sample frames in an audio port that
  23.      have not yet been filled.  How you interpret this number depends on
  24.      whether _p_o_r_t is an input port or an output port.
  25.  
  26.      For an input port, the return value is a count of spaces that the device
  27.      can fill up before the port overflows, causing a loss of samples.
  28.  
  29.      For an output port, the return value is the greatest number of sample
  30.      frames that can be written to the port without blocking (i.e. waiting for
  31.      more samples to be played).
  32.  
  33.      Because the port may continue to empty or fill, the number returned by
  34.      aaaallllGGGGeeeettttFFFFiiiillllllllaaaabbbblllleeee is an instantaneous measurement of the number of fillable
  35.      locations.  For input ports, this number will decrease over time as new
  36.      samples arrive.  For output, ports this number will increase as samples
  37.      are played.
  38.  
  39.      In order to insure the best possible performance, aaaallllGGGGeeeettttFFFFiiiillllllllaaaabbbblllleeee performs
  40.      no verification of _p_o_r_t. You should make certain that _p_o_r_t is a valid
  41.      AAAALLLLppppoooorrrrtttt structure before passing it as a parameter to aaaallllGGGGeeeettttFFFFiiiillllllllaaaabbbblllleeee.
  42.  
  43. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  44.      Upon successful completion, aaaallllGGGGeeeettttFFFFiiiillllllllaaaabbbblllleeee returns a non-negative number.
  45.  
  46. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  47.      alOpenPort(3dm), alGetFilled(3dm)
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.